CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/objects (Post)
Post/projects/{projectId}/objects
Description
Creates or updates an array of objects in the project
Parameters
NameDescriptionData Type
the id of the projectstring
Request (application/json)

The request body is of type object.

Overview

ObjectsInstances : Array[CimObjectInstance]
ID : string
is a string indicating the ID of the object
ClassID : string
is a string indicating the class of the object
Description : string
is a string indicating the description of the object instance
Attributes : Array[CimAttribute]
An array of attributes used in the configuration of the objects instance.
ID : string
is a string indicating the ID of the attribute
Value : string
is a string containing the value of the attribute.
Routing : Array[string]
An array of roles the alarms created by the this object are routed to
OpcUaDeviceContexts : Array[CimOpcUaDeviceContext]
DeviceId : string
The Id of the OPC UA device.
NamespaceUris : Array[string]
An array of URIs referenced by NodeIds or QualifiedNames in the request. NamespaceIndex 0 shall not be in this list. The first entry in this list is NamespaceIndex 1.
ServerUris : Array[string]
A list of URIs referenced by ExpandedNodeIds in the request. ServerIndex 0 shall not be in this list. The first entry in this list is ServerIndex 1.
DynCreate : boolean
200 Response

The response body is of type ItemsPostResponse.

The collection of results from the object create/update operation

Overview

ItemsPostResponse
The results of the create/update/delete operations.
NumSuccesses : number
The number of items that were successfully written.
NumFailures : number
The number of items that failed to be written.
WarningsMask : integer
a bitmask of warning conditions (e.g., WarningLicensePointCount)
ItemResults : Array[ItemResult]
The results for each item in the request array.
Success : boolean
high level result (success true, failure false)
StatusDetails : integer
a value giving more details about the status (e.g., SuccessNew, SuccessModified, FailureDupInRequest, FailureDupInObject, and then a bunch of FailureXyzzy, ...)
WarningsMask : integer
a bitmask of warning conditions (e.g., IE_SNF_NO_GLB_TRIG_MSG)
Message : string
(localized?) message about the result, probably empty for successes
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
Error if objects not found
This fault returns a response body of type ProblemDetails.
General error
See Also